rtc11.h File Reference

This file contains API for RTC 11 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures
struct	rtc11_t
	RTC 11 Click context object. More...
struct	rtc11_cfg_t
	RTC 11 Click configuration object. More...
struct	rtc11_time_t
	RTC 11 Click time object. More...
struct	rtc11_date_t
	RTC 11 Click date object. More...

Macros
#define	RTC11_RD_BIT_MASK   0x7F
	RTC 11 description register. More...
#define	RTC11_WR_BIT_MASK   0x80
#define	RTC11_REG_HDT   0x00
#define	RTC11_REG_SEC   0x01
#define	RTC11_REG_MIN   0x02
#define	RTC11_REG_HRS   0x03
#define	RTC11_REG_DAT   0x04
#define	RTC11_REG_MON   0x05
#define	RTC11_REG_YRS   0x06
#define	RTC11_REG_WKD   0x07
#define	RTC11_REG_ALA_HDT   0x08
#define	RTC11_REG_ALA_SEC   0x09
#define	RTC11_REG_ALA_MIN   0x0A
#define	RTC11_REG_ALA_HRS   0x0B
#define	RTC11_REG_ALA_DAT   0x0C
#define	RTC11_REG_ALA_MON   0x0D
#define	RTC11_REG_ALA_WKD   0x0E
#define	RTC11_REG_STAT   0x0F
#define	RTC11_REG_CTL1   0x10
#define	RTC11_REG_CTL2   0x11
#define	RTC11_REG_INT_MSK   0x12
#define	RTC11_REG_SQW   0x13
#define	RTC11_REG_CAL_XT   0x14
#define	RTC11_REG_CAL_RC_HI   0x15
#define	RTC11_REG_CAL_RC_LOW   0x16
#define	RTC11_REG_INT_POL   0x17
#define	RTC11_REG_TMR_CTL   0x18
#define	RTC11_REG_TMR   0x19
#define	RTC11_REG_TMR_INIT   0x1A
#define	RTC11_REG_WDT   0x1B
#define	RTC11_REG_OSC_CTL   0x1C
#define	RTC11_REG_OSC_STAT   0x1D
#define	RTC11_REG_CFG_KEY   0x1F
#define	RTC11_REG_TRCK   0x20
#define	RTC11_REG_BREF_CTL   0x21
#define	RTC11_REG_BAT_MODE   0x27
#define	RTC11_REG_ID_0   0x28
#define	RTC11_REG_ID_1   0x29
#define	RTC11_REG_ID_2   0x2A
#define	RTC11_REG_ID_3   0x2B
#define	RTC11_REG_ID_4   0x2C
#define	RTC11_REG_ID_5   0x2D
#define	RTC11_REG_ID_6   0x2E
#define	RTC11_REG_ASTAT   0x2F
#define	RTC11_REG_OCTRL   0x30
#define	RTC11_REG_EXT_ADR   0x3F
#define	RTC11_REG_RAM   0x40
#define	RTC11_CTL1_STOP   0x80
	RTC 11 description setting. More...
#define	RTC11_CTL1_12_HRS   0x40
#define	RTC11_CTL1_OUTB   0x20
#define	RTC11_CTL1_OUT   0x10
#define	RTC11_CTL1_ARST   0x04
#define	RTC11_CTL1_WRTC   0x01
#define	RTC11_ACS_OSC_CTL   0xA1
#define	RTC11_SW_RST   0x3C
#define	RTC11_ACS_AN_CTL_REG   0x9D
#define	RTC11_CEB   0x80
#define	RTC11_BLIE   0x10
#define	RTC11_TIE   0x08
#define	RTC11_AIE   0x04
#define	RTC11_EX2E   0x02
#define	RTC11_EX1E   0x01
#define	RTC11_PROP_DIS   0x00
#define	RTC11_PROP_EN   0x01
#define	RTC11_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping. More...

Enumerations
enum	rtc11_return_value_t { RTC11_OK = 0, RTC11_ERROR = -1 }
	RTC 11 Click return value data. More...

Functions
void	rtc11_cfg_setup (rtc11_cfg_t *cfg)
	RTC 11 configuration object setup function. More...
err_t	rtc11_init (rtc11_t *ctx, rtc11_cfg_t *cfg)
	RTC 11 initialization function. More...
void	rtc11_generic_write (rtc11_t *ctx, uint8_t reg, uint8_t *wr_data, uint16_t n_len)
	RTC 11 data writing function. More...
void	rtc11_generic_read (rtc11_t *ctx, uint8_t reg, uint8_t *rd_data, uint16_t n_len)
	RTC 11 data reading function. More...
uint8_t	rtc11_check_irq_1 (rtc11_t *ctx)
	Check Interrupt 1 pin function. More...
uint8_t	rtc11_check_irq_2 (rtc11_t *ctx)
	Check Interrupt 2 pin function. More...
void	rtc11_wdi (rtc11_t *ctx, uint8_t state)
	Watchdog reset function. More...
void	rtc11_ext_int (rtc11_t *ctx, uint8_t state)
	External interrupt function. More...
void	rtc11_set_time_hundredths (rtc11_t *ctx, uint8_t hundredths)
	Set hundredths function. More...
void	rtc11_set_time_seconds (rtc11_t *ctx, uint8_t seconds)
	Set seconds function. More...
void	rtc11_set_time_minutes (rtc11_t *ctx, uint8_t minutes)
	Set minutes function. More...
void	rtc11_set_time_hours (rtc11_t *ctx, uint8_t hours)
	Set hours function. More...
uint8_t	rtc11_get_time_hundredths (rtc11_t *ctx)
	Get hundredths function. More...
uint8_t	rtc11_get_time_seconds (rtc11_t *ctx)
	Get seconds function. More...
uint8_t	rtc11_get_time_minutes (rtc11_t *ctx)
	Get minutes function. More...
uint8_t	rtc11_get_time_hours (rtc11_t *ctx)
	Get hours function. More...
uint8_t	rtc11_get_date_day (rtc11_t *ctx)
	Get day function. More...
void	rtc11_set_date_day (rtc11_t *ctx, uint8_t date_day)
	Set day function. More...
uint8_t	rtc11_get_date_month (rtc11_t *ctx)
	Get month function. More...
void	rtc11_set_date_month (rtc11_t *ctx, uint8_t date_mth)
	Set month function. More...
uint8_t	rtc11_get_date_year (rtc11_t *ctx)
	Get year function. More...
void	rtc11_set_date_year (rtc11_t *ctx, uint16_t date_yrs)
	Set year function. More...
uint8_t	rtc11_get_century_flag (rtc11_t *ctx)
	Get century flag function. More...
uint8_t	rtc11_get_day_of_the_week (rtc11_t *ctx)
	Get day of the week function. More...
void	rtc11_set_day_of_the_week (rtc11_t *ctx, uint8_t w_day)
	Set day of the week function. More...
void	rtc11_set_ala_time_hundredths (rtc11_t *ctx, uint8_t hundredths)
	Set alarm time hundredths function. More...
void	rtc11_set_ala_time_seconds (rtc11_t *ctx, uint8_t seconds)
	Set alarm time seconds function. More...
void	rtc11_set_ala_time_minutes (rtc11_t *ctx, uint8_t minutes)
	Set alarm time minutes function. More...
void	rtc11_set_ala_time_hours (rtc11_t *ctx, uint8_t hours)
	Set alarm time hours function. More...
uint8_t	rtc11_get_ala_time_hundredths (rtc11_t *ctx)
	Get alarm time hundredths function. More...
uint8_t	rtc11_get_ala_time_seconds (rtc11_t *ctx)
	Get alarm time seconds function. More...
uint8_t	rtc11_get_ala_time_minutes (rtc11_t *ctx)
	Get alarm time minutes function. More...
uint8_t	rtc11_get_ala_time_hours (rtc11_t *ctx)
	Get alarm time hours function. More...
uint8_t	rtc11_get_ala_date_day (rtc11_t *ctx)
	Get alarm time days function. More...
void	rtc11_set_ala_date_day (rtc11_t *ctx, uint8_t date_day)
	Set alarm time day function. More...
uint8_t	rtc11_get_ala_date_month (rtc11_t *ctx)
	Get alarm time month function. More...
void	rtc11_set_ala_date_month (rtc11_t *ctx, uint8_t date_mth)
	Set alarm time month function. More...
uint8_t	rtc11_get_ala_day_of_the_week (rtc11_t *ctx)
	Get alarm time day of the week function. More...
void	rtc11_set_ala_day_of_the_week (rtc11_t *ctx, uint8_t w_day)
	Set alarm time day of the week function. More...
void	rtc11_soft_rst (rtc11_t *ctx)
	Software Reset function. More...
err_t	rtc11_set_time (rtc11_t *ctx, rtc11_time_t rtc_time)
	Set time hours, minutes and seconds function. More...
void	rtc11_get_time (rtc11_t *ctx, rtc11_time_t *rtc_time)
	Get time hours, minutes and seconds function. More...
err_t	rtc11_set_date (rtc11_t *ctx, rtc11_date_t rtc_date)
	Set date day of the week, day, month and year function. More...
void	rtc11_get_date (rtc11_t *ctx, rtc11_date_t *rtc_date)
	Get date day of the week, day, month and year function. More...
void	rtc11_stp_sys_slk (rtc11_t *ctx, uint8_t state)
	Stop the clocking system function. More...
void	rtc11_auto_rst (rtc11_t *ctx, uint8_t state)
	Auto reset enable function. More...
void	rtc11_write_rtc (rtc11_t *ctx, uint8_t state)
	Write RTC enable function. More...
void	rtc11_cen_en (rtc11_t *ctx, uint8_t state)
	Century Enable function. More...
void	rtc11_bat_low_int_en (rtc11_t *ctx, uint8_t state)
	Battery Low Interrupt Enable function. More...
void	rtc11_timer_int_en (rtc11_t *ctx, uint8_t state)
	Timer Interrupt Enable function. More...
void	rtc11_alarm_int_en (rtc11_t *ctx, uint8_t state)
	Alarm Interrupt Enable function. More...
void	rtc11_xt2_int_en (rtc11_t *ctx, uint8_t state)
	XT2 Interrupt Enable function. More...
void	rtc11_xt1_int_en (rtc11_t *ctx, uint8_t state)
	XT1 Interrupt Enable function. More...
void	rtc11_bat_mode_en (rtc11_t *ctx, uint8_t state)
	Batmode enable function. More...

Detailed Description

This file contains API for RTC 11 Click Driver.

Enumeration Type Documentation

rtc11_return_value_t

enum rtc11_return_value_t

RTC 11 Click return value data.

Predefined enum values for driver return values.

Enumerator
RTC11_OK
RTC11_ERROR